com.inscoper.api.Constraint¶

Constraint class defines limits and valid values for a parameter. More...

Public Functions¶

	Name
synchronized void	delete()
boolean	isReadOnly() Check if read-only.
EParamType	getType() Get parameter type.
boolean	hasMin() Check if minimum exists.
double	getMin() Get minimum value.
boolean	hasMax() Check if maximum exists.
double	getMax() Get maximum value.
boolean	hasStep() Check if step exists.
double	getStep() Get step value.
boolean	hasKeyList() Check if key list exists.
boolean	hasValueList() Check if value list exists.
StringVector	getValueList() Get value list.
StringVector	getKeyList() Get key list.
EParamType	getKeyType() Get key type.
String	getValue(String key) Retrieves the value associated with a key.
boolean	hasSubConstraint(String property) Check if sub-constraint exists.
Constraint	getSubConstraint(String property) Get sub-constraint.
Constraint	cloneConstraint() Clone constraint.

Protected Functions¶

	Name
	Constraint(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Constraint obj)

Detailed Description¶

public class com.inscoper.api.Constraint;

Constraint class defines limits and valid values for a parameter.

Note: This class is non-copyable and non-movable.

This abstract base class defines constraints on a parameter, such as minimum/maximum values, step size, and valid value lists.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function isReadOnly¶

public boolean isReadOnly()

Check if read-only.

Return: True if the parameter is read-only, false otherwise

Determines if the parameter is read-only.

function getType¶

public EParamType getType()

Get parameter type.

Return: The parameter type (EParamType)

Retrieves the data type of the parameter.

function hasMin¶

public boolean hasMin()

Check if minimum exists.

Return: True if a minimum value is defined, false otherwise

function getMin¶

public double getMin()

Get minimum value.

Return: The minimum valid value

function hasMax¶

public boolean hasMax()

Check if maximum exists.

Return: True if a maximum value is defined, false otherwise

function getMax¶

public double getMax()

Get maximum value.

Return: The maximum valid value

function hasStep¶

public boolean hasStep()

Check if step exists.

Return: True if a step value is defined, false otherwise

function getStep¶

public double getStep()

Get step value.

Return: The step size

function hasKeyList¶

public boolean hasKeyList()

Check if key list exists.

Return: True if a list of valid keys is available, false otherwise

function hasValueList¶

public boolean hasValueList()

Check if value list exists.

Return: True if a list of valid values is available, false otherwise

function getValueList¶

public StringVector getValueList()

Get value list.

Return: A vector of valid value strings

function getKeyList¶

public StringVector getKeyList()

Get key list.

Return: A vector of valid key strings

function getKeyType¶

public EParamType getKeyType()

Get key type.

Return: The type of the keys

function getValue¶

public String getValue(
    String key
)

Retrieves the value associated with a key.

Parameters:

key : The key to look up

Return: The corresponding value

Retrieves the value corresponding to a specific key.

function hasSubConstraint¶

public boolean hasSubConstraint(
    String property
)

Check if sub-constraint exists.

Parameters:

property : The property name to check

Return: True if a sub-constraint exists for the property, false otherwise

Checks if a sub-constraint exists. Sub-constraints are constraints on existing properties.

function getSubConstraint¶

public Constraint getSubConstraint(
    String property
)

Get sub-constraint.

Parameters:

property : The property name

Return: A shared pointer to the sub-constraint, or null if not found

Retrieves a sub-constraint. Sub-constraints are constraints on existing properties.

function cloneConstraint¶

public Constraint cloneConstraint()

Clone constraint.

Return: A shared pointer to the cloned constraint

Creates a deep copy of the constraint.

Protected Functions Documentation¶

function Constraint¶

protected Constraint(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Constraint obj
)

Updated on 2026-04-02 at 10:55:37 +0200